Obtains a handle to a window’s auxiliary window structure.

GetAuxWin ();

function result

Returns a Boolean value that reports whether or not the window has an auxiliary window structure. If the window has no auxiliary window structure, it returns a value of false. If theWindow is NULL, the function returns the system default and true.

DISCUSSION

The GetAuxWin function sets the value referenced through the parameter awHndl to contain a handle to the auxiliary window structure. If the window has no auxiliary window structure, GetAuxWin places the default auxiliary window structure in the value referenced through awHndl.

When the Appearance Manager is available and you are using standard windows, most of the fields of the auxiliary window structure are ignored and the GetAuxWin function is not recommended. In the future, standard system windows may not have entries in the auxiliary window list. If you are creating your own window definition function, GetAuxWin can still be used.

VERSION NOTES

This function is not recommended with Appearance Manager 1.0 and later.

AVAILABILITY

Not supported in Carbon.

CARBON NOTES

Remove application reliance on AuxWinRec data structures; in the future, the information in these structures may be invalid or unavailable to applications.

© 2000 Apple Computer, Inc. — (Last Updated 4/14/2000)